home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 85 / CD Actual 85 Febrero 2004.iso / Experto / Apache / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F252671_mod_auth_anon.xml < prev    next >
Encoding:
Extensible Markup Language  |  2003-04-15  |  7.3 KB  |  204 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <modulesynopsis metafile="mod_auth_anon.xml.meta">
  5.  
  6. <name>mod_auth_anon</name>
  7. <description>Allows "anonymous" user access to authenticated
  8. areas</description>
  9. <status>Extension</status>
  10. <sourcefile>mod_auth_anon.c</sourcefile>
  11. <identifier>auth_anon_module</identifier>
  12. <compatibility>Available only in versions prior to 2.1</compatibility>
  13.  
  14. <summary>
  15.     <p>This module does access control in a manner similar to
  16.     anonymous-ftp sites; <em>i.e.</em> have a 'magic' user id
  17.     'anonymous' and the email address as a password. These email
  18.     addresses can be logged.</p>
  19.  
  20.     <p>Combined with other (database) access control methods, this
  21.     allows for effective user tracking and customization according
  22.     to a user profile while still keeping the site open for
  23.     'unregistered' users. One advantage of using Auth-based user
  24.     tracking is that, unlike magic-cookies and funny URL
  25.     pre/postfixes, it is completely browser independent and it
  26.     allows users to share URLs.</p>
  27. </summary>
  28.  
  29. <section id="example"><title>Example</title>
  30.  
  31.     <p>The example below (when combined with the Auth directives of a
  32.     htpasswd-file based (or GDM, mSQL etc.) base access
  33.     control system allows users in as 'guests' with the following
  34.     properties:</p>
  35.  
  36.     <ul>
  37.       <li>It insists that the user enters a userId.
  38.       (<code>Anonymous_NoUserId</code>)</li>
  39.  
  40.       <li>It insists that the user enters a password.
  41.       (<code>Anonymous_MustGiveEmail</code>)</li>
  42.  
  43.       <li>The password entered must be a valid email address, ie.
  44.       contain at least one '@' and a '.'.
  45.       (<code>Anonymous_VerifyEmail</code>)</li>
  46.  
  47.       <li>The userID must be one of <code>anonymous guest www test
  48.       welcome</code> and comparison is <strong>not</strong> case
  49.       sensitive.</li>
  50.  
  51.       <li>And the Email addresses entered in the passwd field are
  52.       logged to the error log file
  53.       (<code>Anonymous_LogEmail</code>)</li>
  54.     </ul>
  55.  
  56.     <example><title>Excerpt of httpd.conf:</title>
  57.       Anonymous_NoUserId off<br />
  58.       Anonymous_MustGiveEmail on<br />
  59.       Anonymous_VerifyEmail on<br />
  60.       Anonymous_LogEmail on<br />
  61.       Anonymous anonymous guest www test welcome<br />
  62.       <br />
  63.       AuthName "Use 'anonymous' & Email address for guest entry"<br />
  64.       AuthType basic<br />
  65.       <br />
  66.       # An
  67.       AuthUserFile/AuthDBUserFile/AuthDBMUserFile<br />
  68.       # directive must be specified, or use<br />
  69.       # Anonymous_Authoritative for public access.<br />
  70.       # In the .htaccess for the public directory, add:<br />
  71.       <Files *><br />
  72.       <indent>
  73.         Order Deny,Allow<br />
  74.         Allow from all<br />
  75.         <br />
  76.         Require valid-user<br />
  77.       </indent>
  78.       </Files>
  79.     </example>
  80. </section>
  81.  
  82. <directivesynopsis>
  83. <name>Anonymous</name>
  84. <description>Specifies userIDs that areallowed access without
  85. password verification</description>
  86. <syntax>Anonymous <var>user</var> [<var>user</var>] ...</syntax>
  87. <contextlist><context>directory</context><context>.htaccess</context>
  88. </contextlist>
  89. <override>AuthConfig</override>
  90.  
  91. <usage>
  92.     <p>A list of one or more 'magic' userIDs which are allowed
  93.     access without password verification. The userIDs are space
  94.     separated. It is possible to use the ' and " quotes to allow a
  95.     space in a userID as well as the \ escape character.</p>
  96.  
  97.     <p>Please note that the comparison is
  98.     <strong>case-IN-sensitive</strong>.<br />
  99.      I strongly suggest that the magic username
  100.     '<code>anonymous</code>' is always one of the allowed
  101.     userIDs.</p>
  102.  
  103.     <example><title>Example:</title>
  104.       Anonymous anonymous "Not Registered" "I don't know"
  105.     </example>
  106.  
  107.     <p>This would allow the user to enter without password
  108.     verification by using the userIDs "anonymous",
  109.     "AnonyMous", "Not Registered" and "I Don't Know".</p>
  110. </usage>
  111. </directivesynopsis>
  112.  
  113. <directivesynopsis>
  114. <name>Anonymous_Authoritative</name>
  115. <description>Configures if authorization will fall-through
  116. to other methods</description>
  117. <syntax>Anonymous_Authoritative On|Off</syntax>
  118. <default>Anonymous_Authoritative Off</default>
  119. <contextlist><context>directory</context><context>.htaccess</context>
  120. </contextlist>
  121. <override>AuthConfig</override>
  122.  
  123. <usage>
  124.     <p>When set <code>On</code>, there is no fall-through to other
  125.     authentication methods. So if a userID does not match the values
  126.     specified in the <directive module="mod_auth_anon">Anonymous</directive>
  127.     directive, access is denied.</p>
  128.  
  129.     <p>Be sure you know what you are doing when you decide to
  130.     switch it on. And remember that the order in which the Authentication
  131.     modules are queried is defined in the modules.c files at compile
  132.     time.</p>
  133. </usage>
  134. </directivesynopsis>
  135.  
  136. <directivesynopsis>
  137. <name>Anonymous_LogEmail</name>
  138. <description>Sets whether the password entered will be logged in the
  139. error log</description>
  140. <syntax>Anonymous_LogEmail On|Off</syntax>
  141. <default>Anonymous_LogEmail On</default>
  142. <contextlist><context>directory</context><context>.htaccess</context>
  143. </contextlist>
  144. <override>AuthConfig</override>
  145.  
  146. <usage>
  147.     <p>When set <code>On</code>, the default, the 'password' entered
  148.     (which hopefully contains a sensible email address) is logged in
  149.     the error log.</p>
  150. </usage>
  151. </directivesynopsis>
  152.  
  153. <directivesynopsis>
  154. <name>Anonymous_MustGiveEmail</name>
  155. <description>Specifies whether blank passwords are allowed</description>
  156. <syntax>Anonymous_MustGiveEmail On|Off</syntax>
  157. <default>Anonymous_MustGiveEmail On</default>
  158. <contextlist><context>directory</context><context>.htaccess</context>
  159. </contextlist>
  160. <override>AuthConfig</override>
  161.  
  162. <usage>
  163.     <p>Specifies whether the user must specify an email address as
  164.     the password. This prohibits blank passwords.</p>
  165. </usage>
  166. </directivesynopsis>
  167.  
  168. <directivesynopsis>
  169. <name>Anonymous_NoUserID</name>
  170. <description>Sets whether the userID field may be empty</description>
  171. <syntax>Anonymous_NoUserID On|Off</syntax>
  172. <default>Anonymous_NoUserID Off</default>
  173. <contextlist><context>directory</context><context>.htaccess</context>
  174. </contextlist>
  175. <override>AuthConfig</override>
  176.  
  177. <usage>
  178.     <p>When set <code>On</code>, users can leave the userID (and
  179.     perhaps the password field) empty. This can be very convenient for
  180.     MS-Explorer users who can just hit return or click directly on the
  181.     OK button; which seems a natural reaction.</p>
  182. </usage>
  183. </directivesynopsis>
  184.  
  185. <directivesynopsis>
  186. <name>Anonymous_VerifyEmail</name>
  187. <description>Sets whether to check the password field for a correctly
  188. formatted email address</description>
  189. <syntax>Anonymous_VerifyEmail On|Off</syntax>
  190. <default>Anonymous_VerifyEmail Off</default>
  191. <contextlist><context>directory</context><context>.htaccess</context>
  192. </contextlist>
  193. <override>AuthConfig</override>
  194.  
  195. <usage>
  196.     <p>When set <code>On</code> the 'password' entered is checked for
  197.     at least one '@' and a '.' to encourage users to enter valid email
  198.     addresses (see the above <directive
  199.     module="mod_auth_anon">Anonymous_LogEmail</directive>).</p>
  200. </usage>
  201. </directivesynopsis>
  202.  
  203. </modulesynopsis>
  204.